/projects/{projectId}/users:read (Post)

Post	/projects/{projectId}/users:read

In This Topic

Description

Gets an array of users objects that satisfy the filter criteria specified in the request body.

Parameters

Name	Description	Data Type
projectId	the id of the project	string

Request (application/json)

The request body is of type object.

UserID : string

provides a wild card string to filter users by their UserID.

RoleID : string

provides a wild card string to filter users by their RoleID.

limit : integer

skip : integer

200 Response

The response body is of type UsersGetResponse.

The collection of users that satisfy the query.

UsersGetResponse

The results of the users get query.

Users : Array[CimUser]

An array of the users that satify the query criteria.

AuthenticationType : CimUserType

Enable : boolean

set it to true to enable the user.

PasswordExpiresInDays : number

password expires in number of configured days.

Password : string

Password for the user.

Resources : Array[string]

An array of resources that mapped to the user.

RoleID : string

The Id of role.

UserID : string

The Id of user.

UserName : string

The name of user.

Fault Responses

Fault	Description
404	This fault returns a response body of type ProblemDetails. project with the given id is not registered on the system

Remarks

Returns JSON containing an array of CIMPLICITY user objects